OpenEdge Data Management:<br />Database Administration DBTOOL utility

DBTOOL utility

Diagnostic tool that identifies possible record issues and fixes SQL Width violations.

Syntax


`dbtool` `db-name`

Parameters


db-name

Name of the database to be scanned.

When you enter the DBTOOL utility, the main menu appears as follows:

DATABASE TOOLS MENU - 10.1a -------------------------- 1. SQL Width & Date Scan w/Report Option 2. SQL Width Scan w/Fix Option 3. Record Validation 4. Record Version Validation 5. Read database block(s) 6. Record fixup 9. Enable/Disable File Logging Q. Quit Choice:

                     DATABASE TOOLS MENU - 10.1a 
                     -------------------------- 
                  
                1. SQL Width & Date Scan w/Report Option 
                2. SQL Width Scan w/Fix Option 
                3. Record Validation 
                4. Record Version Validation 
                5. Read database block(s) 
                6. Record fixup 
                9. Enable/Disable File Logging 
                  
                Q. Quit 
                Choice:

Figure 23–1: DBTOOL main menu

The menu options provide the following functions:

SQL Width & Date Scan w/Report Option — This option reports on the following SQL values:

_Field._Width

year_value<0

year_value>9999

In the generated report, three asterisks (***) in the Error column indicate SQL width or date violations.

SQL Width Scan w/Fix Option — This option scans for width violations over the specified percentage of the current maximum width, and increases SQL width when necessary. You are prompted to enter a number indicating the percentage above the current maximum width to allocate for record growth.

For example, if the current maximum width of a field is 100, and you specify 10 percent for growth, DBTOOL checks the SQL Width of the field, and if it is less than 110, increases it to 110. If SQL Width is larger than the field’s current maximum width plus the percentage for growth, SQL Width is not changed.

Record Validation — This option compares the physical storage of the record to the schema definition and reports discrepancies.

Record Version Validation — This option performs record validation before and after upgrading the schema version of a record. The first check compares the record to the current schema definition in the record header. After that check completes, if the table has a newer definition of the schema than the record, the record schema is updated, and then the physical record is compared to the new definition.

Read database block(s) — This option validates the information in the database block header.

Record fixup — This option scans records for indications of possible corruption.

Enable/Disable File Logging — This option toggles the redirection of the tool output to a file named dbtool.out. DBTOOL writes this file to your current working directory.

For menu options 1-6, you must know if your database has a server running or not. You will be prompted to connect to the database as follows.

To run options 1-6 of DBTOOL:

Enter your choice at the main menu prompt. The following prompt appears:


`<connect>:(0=single-user 1=self-service >1=#threads)?`

Enter your connection type (0, 1, or #threads).

If a database broker is not running, you must select 0. If a database broker is running, you can run the report using one or more threads. If you enter a connection type that does not match the state of the database, DBTOOL returns this error:


`dsmUserConnect failed rc = -1`

After you enter a valid connection code, the prompts specific to the functionality of your selection appear.

Continue through the remaining prompts for your option. Common prompts include the following:

Table — Enter the table number at the following prompt:


`<table>: (Table number or all)?`

Area — Enter the area number at the following prompt:


<area>: (Area number or all)?

Display — Enter the verbose level. The verbose level defines the amount of output displayed, with zero being the least verbose. The following prompt appears for display:


<display>: (verbose level 0-3)?

Notes

DBTOOL is a multi-threaded utility. The connection type you specify when running the utility determines the number of threads DBTOOL will run. Because each thread uses a database connection, be aware of what the broker startup parameter (-n) is set to. Specifying 1.5*(number of CPUs) as the number of threads to run DBTOOL with is usually adequate.

DBTOOL sends output to .stdout. To redirect output to a file, enter the following syntax when starting DBTOOL:


dbtool `db-name` `2 >` `filename.out`

If you decide to redirect output after entering DBTOOL, select Enable/Disable File Logging from the DBTOOL menu. This option redirects the output to a file named dbtool.out. DBTOOL writes this file to your current working directory.

DBTOOL does not fix date errors. It only identifies them. To fix date errors, use the Data Dictionary or Data Administration tool to modify the fields that contain incompatible date values.